Opto 8 Click Driver

API for configuring and manipulating Opto 8 Click driver. More...

Topics
	Opto 8 MikroBUS Map
	MikroBUS pin mapping of Opto 8 Click driver.

Functions
void	opto8_cfg_setup (opto8_cfg_t *cfg)
	Opto 8 configuration object setup function.
err_t	opto8_init (opto8_t *ctx, opto8_cfg_t *cfg)
	Opto 8 initialization function.
void	opto8_set_out1 (opto8_t *ctx)
	Opto 8 set OUT1 function.
void	opto8_clear_out1 (opto8_t *ctx)
	Opto 8 clear OUT1 function.
void	opto8_toggle_out1 (opto8_t *ctx)
	Opto 8 toggle OUT1 function.
void	opto8_set_out2 (opto8_t *ctx)
	Opto 8 set OUT2 function.
void	opto8_clear_out2 (opto8_t *ctx)
	Opto 8 clear OUT2 function.
void	opto8_toggle_out2 (opto8_t *ctx)
	Opto 8 toggle OUT2 function.
uint8_t	opto8_get_in1 (opto8_t *ctx)
	Opto 8 get IN1 function.
uint8_t	opto8_get_in2 (opto8_t *ctx)
	Opto 8 get IN2 function.

Detailed Description

API for configuring and manipulating Opto 8 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

opto8_cfg_setup()

void opto8_cfg_setup

(

opto8_cfg_t *

cfg

)

Opto 8 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See opto8_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

opto8_clear_out1()

void opto8_clear_out1

(

opto8_t *

ctx

)

Opto 8 clear OUT1 function.

This function clears the output 1 control pin to low logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

None.

Note

None.

opto8_clear_out2()

void opto8_clear_out2

(

opto8_t *

ctx

)

Opto 8 clear OUT2 function.

This function clears the output 2 control pin to low logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

None.

Note

None.

opto8_get_in1()

uint8_t opto8_get_in1

(

opto8_t *

ctx

)

Opto 8 get IN1 function.

This function reads the input 1 status pin logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

• 0 - Low pin state,
• 1 - High pin state.

Note

None.

opto8_get_in2()

uint8_t opto8_get_in2

(

opto8_t *

ctx

)

Opto 8 get IN2 function.

This function reads the input 2 status pin logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

• 0 - Low pin state,
• 1 - High pin state.

Note

None.

opto8_init()

err_t opto8_init	(	opto8_t *	ctx,
		opto8_cfg_t *	cfg )

Opto 8 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See opto8_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See opto8_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

opto8_set_out1()

void opto8_set_out1

(

opto8_t *

ctx

)

Opto 8 set OUT1 function.

This function sets the output 1 control pin to high logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

None.

Note

None.

opto8_set_out2()

void opto8_set_out2

(

opto8_t *

ctx

)

Opto 8 set OUT2 function.

This function sets the output 2 control pin to high logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

None.

Note

None.

opto8_toggle_out1()

void opto8_toggle_out1

(

opto8_t *

ctx

)

Opto 8 toggle OUT1 function.

This function toggles the output 1 control pin logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

None.

Note

None.

opto8_toggle_out2()

void opto8_toggle_out2

(

opto8_t *

ctx

)

Opto 8 toggle OUT2 function.

This function toggles the output 2 control pin logic state.

Parameters

[in]

ctx

: Click context object. See opto8_t object definition for detailed explanation.

Returns

None.

Note

None.